<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Voro++: wall.hh Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Voro++
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">wall.hh</div>  </div>
</div>
<div class="contents">
<a href="wall_8hh.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Voro++, a 3D cell-based Voronoi library</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Author   : Chris H. Rycroft (LBL / UC Berkeley)</span>
<a name="l00004"></a>00004 <span class="comment">// Email    : chr@alum.mit.edu</span>
<a name="l00005"></a>00005 <span class="comment">// Date     : August 30th 2011</span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment">/** \file wall.hh</span>
<a name="l00008"></a>00008 <span class="comment"> * \brief Header file for the derived wall classes. */</span>
<a name="l00009"></a>00009 
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef VOROPP_WALL_HH</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define VOROPP_WALL_HH</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &quot;<a class="code" href="cell_8hh.html" title="Header file for the voronoicell and related classes.">cell.hh</a>&quot;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &quot;<a class="code" href="container_8hh.html" title="Header file for the container_base and related classes.">container.hh</a>&quot;</span>
<a name="l00015"></a>00015 
<a name="l00016"></a>00016 <span class="keyword">namespace </span>voro {
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">/** \brief A class representing a spherical wall object.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * This class represents a spherical wall object. */</span>
<a name="l00021"></a><a class="code" href="structvoro_1_1wall__sphere.html">00021</a> <span class="keyword">struct </span><a class="code" href="structvoro_1_1wall__sphere.html" title="A class representing a spherical wall object.">wall_sphere</a> : <span class="keyword">public</span> <a class="code" href="classvoro_1_1wall.html" title="Pure virtual class from which wall objects are derived.">wall</a> {
<a name="l00022"></a>00022         <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment">                /** Constructs a spherical wall object.</span>
<a name="l00024"></a>00024 <span class="comment">                 * \param[in] w_id_ an ID number to associate with the wall for</span>
<a name="l00025"></a>00025 <span class="comment">                 *                  neighbor tracking.</span>
<a name="l00026"></a>00026 <span class="comment">                 * \param[in] (xc_,yc_,zc_) a position vector for the sphere&#39;s</span>
<a name="l00027"></a>00027 <span class="comment">                 *                          center.</span>
<a name="l00028"></a>00028 <span class="comment">                 * \param[in] rc_ the radius of the sphere. */</span>
<a name="l00029"></a><a class="code" href="structvoro_1_1wall__sphere.html#ad37f5096c5b84ffe6c011047a5ac9f78">00029</a>                 <a class="code" href="structvoro_1_1wall__sphere.html#ad37f5096c5b84ffe6c011047a5ac9f78">wall_sphere</a>(<span class="keywordtype">double</span> xc_,<span class="keywordtype">double</span> yc_,<span class="keywordtype">double</span> zc_,<span class="keywordtype">double</span> rc_,<span class="keywordtype">int</span> w_id_=-99)
<a name="l00030"></a>00030                         : w_id(w_id_), xc(xc_), yc(yc_), zc(zc_), rc(rc_) {}
<a name="l00031"></a>00031                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__sphere.html#a08695201299833a5ccebecc016fe8413">point_inside</a>(<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00032"></a>00032                 <span class="keyword">template</span>&lt;<span class="keyword">class</span> v_cell&gt;
<a name="l00033"></a>00033                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__sphere.html#a3779ab19fab2ed104f8a8c0bdb5773b4">cut_cell_base</a>(v_cell &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00034"></a><a class="code" href="structvoro_1_1wall__sphere.html#a0ded43a5ed66e6099203c780e03e1fff">00034</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__sphere.html#a0ded43a5ed66e6099203c780e03e1fff">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell.html" title="Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information...">voronoicell</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__sphere.html#a3779ab19fab2ed104f8a8c0bdb5773b4">cut_cell_base</a>(c,x,y,z);}
<a name="l00035"></a><a class="code" href="structvoro_1_1wall__sphere.html#a67f806cace710d4cbca901ef9228a197">00035</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__sphere.html#a67f806cace710d4cbca901ef9228a197">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell__neighbor.html" title="Extension of the voronoicell_base class to represent a Voronoi cell with neighbor information...">voronoicell_neighbor</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__sphere.html#a3779ab19fab2ed104f8a8c0bdb5773b4">cut_cell_base</a>(c,x,y,z);}
<a name="l00036"></a>00036         <span class="keyword">private</span>:
<a name="l00037"></a>00037                 <span class="keyword">const</span> <span class="keywordtype">int</span> w_id;
<a name="l00038"></a>00038                 <span class="keyword">const</span> <span class="keywordtype">double</span> xc,yc,zc,rc;
<a name="l00039"></a>00039 };
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/** \brief A class representing a plane wall object.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * This class represents a single plane wall object. */</span>
<a name="l00044"></a><a class="code" href="structvoro_1_1wall__plane.html">00044</a> <span class="keyword">struct </span><a class="code" href="structvoro_1_1wall__plane.html" title="A class representing a plane wall object.">wall_plane</a> : <span class="keyword">public</span> <a class="code" href="classvoro_1_1wall.html" title="Pure virtual class from which wall objects are derived.">wall</a> {
<a name="l00045"></a>00045         <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment">                /** Constructs a plane wall object.</span>
<a name="l00047"></a>00047 <span class="comment">                 * \param[in] (xc_,yc_,zc_) a normal vector to the plane.</span>
<a name="l00048"></a>00048 <span class="comment">                 * \param[in] ac_ a displacement along the normal vector.</span>
<a name="l00049"></a>00049 <span class="comment">                 * \param[in] w_id_ an ID number to associate with the wall for</span>
<a name="l00050"></a>00050 <span class="comment">                 *                  neighbor tracking. */</span>
<a name="l00051"></a><a class="code" href="structvoro_1_1wall__plane.html#adb486dd12e7369e4791b625f362c4df2">00051</a>                 <a class="code" href="structvoro_1_1wall__plane.html#adb486dd12e7369e4791b625f362c4df2">wall_plane</a>(<span class="keywordtype">double</span> xc_,<span class="keywordtype">double</span> yc_,<span class="keywordtype">double</span> zc_,<span class="keywordtype">double</span> ac_,<span class="keywordtype">int</span> w_id_=-99)
<a name="l00052"></a>00052                         : w_id(w_id_), xc(xc_), yc(yc_), zc(zc_), ac(ac_) {}
<a name="l00053"></a>00053                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__plane.html#a8168f370f6817ccbd4870b1494b4321d">point_inside</a>(<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00054"></a>00054                 <span class="keyword">template</span>&lt;<span class="keyword">class</span> v_cell&gt;
<a name="l00055"></a>00055                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__plane.html#a8d2515cef30dbd7594a4403d502b4fe5">cut_cell_base</a>(v_cell &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00056"></a><a class="code" href="structvoro_1_1wall__plane.html#a879c5551eb1d97677b0b0651b7da0ddd">00056</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__plane.html#a879c5551eb1d97677b0b0651b7da0ddd">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell.html" title="Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information...">voronoicell</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__plane.html#a8d2515cef30dbd7594a4403d502b4fe5">cut_cell_base</a>(c,x,y,z);}
<a name="l00057"></a><a class="code" href="structvoro_1_1wall__plane.html#ae2103d51a50887cea07671b4e8a0b713">00057</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__plane.html#ae2103d51a50887cea07671b4e8a0b713">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell__neighbor.html" title="Extension of the voronoicell_base class to represent a Voronoi cell with neighbor information...">voronoicell_neighbor</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__plane.html#a8d2515cef30dbd7594a4403d502b4fe5">cut_cell_base</a>(c,x,y,z);}
<a name="l00058"></a>00058         <span class="keyword">private</span>:
<a name="l00059"></a>00059                 <span class="keyword">const</span> <span class="keywordtype">int</span> w_id;
<a name="l00060"></a>00060                 <span class="keyword">const</span> <span class="keywordtype">double</span> xc,yc,zc,ac;
<a name="l00061"></a>00061 };
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment">/** \brief A class representing a cylindrical wall object.</span>
<a name="l00064"></a>00064 <span class="comment"> *</span>
<a name="l00065"></a>00065 <span class="comment"> * This class represents a open cylinder wall object. */</span>
<a name="l00066"></a><a class="code" href="structvoro_1_1wall__cylinder.html">00066</a> <span class="keyword">struct </span><a class="code" href="structvoro_1_1wall__cylinder.html" title="A class representing a cylindrical wall object.">wall_cylinder</a> : <span class="keyword">public</span> <a class="code" href="classvoro_1_1wall.html" title="Pure virtual class from which wall objects are derived.">wall</a> {
<a name="l00067"></a>00067         <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">                /** Constructs a cylinder wall object.</span>
<a name="l00069"></a>00069 <span class="comment">                 * \param[in] (xc_,yc_,zc_) a point on the axis of the</span>
<a name="l00070"></a>00070 <span class="comment">                 *                          cylinder.</span>
<a name="l00071"></a>00071 <span class="comment">                 * \param[in] (xa_,ya_,za_) a vector pointing along the</span>
<a name="l00072"></a>00072 <span class="comment">                 *                          direction of the cylinder.</span>
<a name="l00073"></a>00073 <span class="comment">                 * \param[in] rc_ the radius of the cylinder</span>
<a name="l00074"></a>00074 <span class="comment">                 * \param[in] w_id_ an ID number to associate with the wall for</span>
<a name="l00075"></a>00075 <span class="comment">                 *                  neighbor tracking. */</span>
<a name="l00076"></a><a class="code" href="structvoro_1_1wall__cylinder.html#a15485959acf214d9eafa8a03e066196c">00076</a>                 <a class="code" href="structvoro_1_1wall__cylinder.html#a15485959acf214d9eafa8a03e066196c">wall_cylinder</a>(<span class="keywordtype">double</span> xc_,<span class="keywordtype">double</span> yc_,<span class="keywordtype">double</span> zc_,<span class="keywordtype">double</span> xa_,<span class="keywordtype">double</span> ya_,<span class="keywordtype">double</span> za_,<span class="keywordtype">double</span> rc_,<span class="keywordtype">int</span> w_id_=-99)
<a name="l00077"></a>00077                         : w_id(w_id_), xc(xc_), yc(yc_), zc(zc_), xa(xa_), ya(ya_), za(za_),
<a name="l00078"></a>00078                         asi(1/(xa_*xa_+ya_*ya_+za_*za_)), rc(rc_) {}
<a name="l00079"></a>00079                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cylinder.html#a338b12542139088159acac3f5face2f7">point_inside</a>(<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00080"></a>00080                 <span class="keyword">template</span>&lt;<span class="keyword">class</span> v_cell&gt;
<a name="l00081"></a>00081                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cylinder.html#ada478166ad7607c53d691608c7806cca">cut_cell_base</a>(v_cell &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00082"></a><a class="code" href="structvoro_1_1wall__cylinder.html#a8121adc120f17770099eadc73b5c4f99">00082</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cylinder.html#a8121adc120f17770099eadc73b5c4f99">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell.html" title="Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information...">voronoicell</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__cylinder.html#ada478166ad7607c53d691608c7806cca">cut_cell_base</a>(c,x,y,z);}
<a name="l00083"></a><a class="code" href="structvoro_1_1wall__cylinder.html#af10e0a8cd87d46629b42b8443daf95cb">00083</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cylinder.html#af10e0a8cd87d46629b42b8443daf95cb">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell__neighbor.html" title="Extension of the voronoicell_base class to represent a Voronoi cell with neighbor information...">voronoicell_neighbor</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__cylinder.html#ada478166ad7607c53d691608c7806cca">cut_cell_base</a>(c,x,y,z);}
<a name="l00084"></a>00084         <span class="keyword">private</span>:
<a name="l00085"></a>00085                 <span class="keyword">const</span> <span class="keywordtype">int</span> w_id;
<a name="l00086"></a>00086                 <span class="keyword">const</span> <span class="keywordtype">double</span> xc,yc,zc,xa,ya,za,asi,rc;
<a name="l00087"></a>00087 };
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/** \brief A class representing a conical wall object.</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * This class represents a cone wall object. */</span>
<a name="l00093"></a><a class="code" href="structvoro_1_1wall__cone.html">00093</a> <span class="keyword">struct </span><a class="code" href="structvoro_1_1wall__cone.html" title="A class representing a conical wall object.">wall_cone</a> : <span class="keyword">public</span> <a class="code" href="classvoro_1_1wall.html" title="Pure virtual class from which wall objects are derived.">wall</a> {
<a name="l00094"></a>00094         <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">                /** Constructs a cone wall object.</span>
<a name="l00096"></a>00096 <span class="comment">                 * \param[in] (xc_,yc_,zc_) the apex of the cone.</span>
<a name="l00097"></a>00097 <span class="comment">                 * \param[in] (xa_,ya_,za_) a vector pointing along the axis of</span>
<a name="l00098"></a>00098 <span class="comment">                 *                          the cone.</span>
<a name="l00099"></a>00099 <span class="comment">                 * \param[in] ang the angle (in radians) of the cone, measured</span>
<a name="l00100"></a>00100 <span class="comment">                 *                from the axis.</span>
<a name="l00101"></a>00101 <span class="comment">                 * \param[in] w_id_ an ID number to associate with the wall for</span>
<a name="l00102"></a>00102 <span class="comment">                 *                  neighbor tracking. */</span>
<a name="l00103"></a><a class="code" href="structvoro_1_1wall__cone.html#a7ff2b2acc21eeb2539d08970b3aeb010">00103</a>                 <a class="code" href="structvoro_1_1wall__cone.html#a7ff2b2acc21eeb2539d08970b3aeb010">wall_cone</a>(<span class="keywordtype">double</span> xc_,<span class="keywordtype">double</span> yc_,<span class="keywordtype">double</span> zc_,<span class="keywordtype">double</span> xa_,<span class="keywordtype">double</span> ya_,<span class="keywordtype">double</span> za_,<span class="keywordtype">double</span> ang,<span class="keywordtype">int</span> w_id_=-99)
<a name="l00104"></a>00104                         : w_id(w_id_), xc(xc_), yc(yc_), zc(zc_), xa(xa_), ya(ya_), za(za_),
<a name="l00105"></a>00105                         asi(1/(xa_*xa_+ya_*ya_+za_*za_)),
<a name="l00106"></a>00106                         gra(tan(ang)), sang(sin(ang)), cang(cos(ang)) {}
<a name="l00107"></a>00107                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cone.html#a5bcbbcdbe0c36285c6630dd92380a091">point_inside</a>(<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00108"></a>00108                 <span class="keyword">template</span>&lt;<span class="keyword">class</span> v_cell&gt;
<a name="l00109"></a>00109                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cone.html#ad39d47ee5d007dab3728e45efdaf0db7">cut_cell_base</a>(v_cell &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z);
<a name="l00110"></a><a class="code" href="structvoro_1_1wall__cone.html#a2a007e376f93c3ae5608eb53e4a52261">00110</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cone.html#a2a007e376f93c3ae5608eb53e4a52261">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell.html" title="Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information...">voronoicell</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__cone.html#ad39d47ee5d007dab3728e45efdaf0db7">cut_cell_base</a>(c,x,y,z);}
<a name="l00111"></a><a class="code" href="structvoro_1_1wall__cone.html#ab8ac7eb3a051ba3c3816dd941bdf4eeb">00111</a>                 <span class="keywordtype">bool</span> <a class="code" href="structvoro_1_1wall__cone.html#ab8ac7eb3a051ba3c3816dd941bdf4eeb">cut_cell</a>(<a class="code" href="classvoro_1_1voronoicell__neighbor.html" title="Extension of the voronoicell_base class to represent a Voronoi cell with neighbor information...">voronoicell_neighbor</a> &amp;c,<span class="keywordtype">double</span> x,<span class="keywordtype">double</span> y,<span class="keywordtype">double</span> z) {<span class="keywordflow">return</span> <a class="code" href="structvoro_1_1wall__cone.html#ad39d47ee5d007dab3728e45efdaf0db7">cut_cell_base</a>(c,x,y,z);}
<a name="l00112"></a>00112         <span class="keyword">private</span>:
<a name="l00113"></a>00113                 <span class="keyword">const</span> <span class="keywordtype">int</span> w_id;
<a name="l00114"></a>00114                 <span class="keyword">const</span> <span class="keywordtype">double</span> xc,yc,zc,xa,ya,za,asi,gra,sang,cang;
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118 
<a name="l00119"></a>00119 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>


<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 23 2011 22:49:06 for Voro++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
